#include-Once

; #INDEX# =======================================================================================================================
; Title .........: WinClickPro Functions
; AutoIt Version : 3.2.10++
; Language ......: English
; Description ...: Common functions used with WinClickPro Actions (scripts).
; Author(s) .....: GrayDwarf
; ===============================================================================================================================

; #CURRENT# =====================================================================================================================
; _ErrorMessage
; _M
; _TokenConverter
; ===============================================================================================================================

; #INTERNAL_USE_ONLY# ===========================================================================================================
;__ExampleTOShowDoubleUnderscore
; ===============================================================================================================================

; #FUNCTION# ====================================================================================================================
; Name...........: _ErrorMessage
; Description ...: Called by WinClickPro scripts to display a common error dialog
; Syntax.........: _ErrorMessage($sMessage)
; Parameters ....: $sMessage - The error message you want to display.
; Return values .: None
; Author ........: GrayDwarf
; Modified.......:
; Remarks .......:
; Related .......:
; Link ..........:
; ===============================================================================================================================
Func _DisplayErrorAndExit($sMessage)
	MsgBox(0, @ScriptName, "Error Message: " & $sMessage)
	Exit -1
EndFunc   ;==>_ErrorMessage

; #FUNCTION# ====================================================================================================================
; Name...........: _M
; Description ...: Called by WinClickPro scripts to display a common dialog
; Syntax.........: _M($sMessage)
; Parameters ....: $sMessage - The message you want to display.
; Return values .: None
; Author ........: GrayDwarf
; Modified.......:
; Remarks .......:
; Related .......:
; Link ..........:
; ===============================================================================================================================
Func _M($sMessage)
	MsgBox(0, @ScriptName, "Message: " & $sMessage)
EndFunc   ;==>_Message

; #FUNCTION# ====================================================================================================================
; Name...........: __TokenConverter
; Description ...: Called by WinClickPro scripts to convert tokens into valid AutoIt characters
; Syntax.........: __TokenConverter($sStringWithTokensMessage)
; Parameters ....: $sStringWithTokensMessage - The string you want to convert all instances of any token into a cooresponding character
; Return values .: untokenized string
; Author ........: GrayDwarf
; Modified.......:
; Remarks .......:
; Related .......:
; Link ..........:
; ===============================================================================================================================
Func _TokenConverter($sStringWithTokensMessage)
	Local $sNewString = StringReplace($sStringWithTokensMessage, "WCP_DQ_TOKEN", """")
	$sNewString = StringReplace($sNewString, "WCP_SQ_TOKEN", "'")
	return $sNewString
EndFunc   ;==>_Message